is-equal-shallow

What is is-equal-shallow?

The is-equal-shallow npm package is designed to perform shallow equality checks on objects or arrays. It is particularly useful when you need to quickly determine if two objects have the same top-level properties without deeply traversing their structures. This can be especially handy in optimizations where deep equality checks are too costly in terms of performance.

What are is-equal-shallow's main functionalities?

Shallow equality check for objects

This feature allows you to compare two objects to see if they have the same top-level properties and values. It's useful for checking if objects are 'equivalent' without considering nested properties.

{"const isEqualShallow = require('is-equal-shallow');\nconst obj1 = { a: 1, b: 2 };\nconst obj2 = { a: 1, b: 2 };\nconsole.log(isEqualShallow(obj1, obj2)); // true"}

Shallow equality check for arrays

Similar to objects, this feature enables shallow comparison of two arrays to determine if they contain the same elements in the same order, without going into nested arrays or objects.

{"const isEqualShallow = require('is-equal-shallow');\nconst arr1 = [1, 2, 3];\nconst arr2 = [1, 2, 3];\nconsole.log(isEqualShallow(arr1, arr2)); // true"}

Other packages similar to is-equal-shallow

shallow-equal

Similar to is-equal-shallow, shallow-equal provides functionality for performing shallow equality checks. The main difference lies in the implementation details and the specific use cases each package might be optimized for. While is-equal-shallow focuses on a straightforward approach, shallow-equal might offer additional customization options or optimizations for specific scenarios.

shallowequal

shallowequal is another package that offers similar functionality to is-equal-shallow, allowing for shallow comparison of objects and arrays. The key difference might be in the API design or additional features such as custom comparator functions, which can provide more flexibility in how comparisons are performed.

README

is-equal-shallow

Does a shallow comparison of two objects, returning false if the keys or values differ.

The purpose of this lib is to do the fastest comparison possible of two objects when the values will predictably be primitives.

• only compares objects.
• only compares the first level of each object
• values must be primitives. If a value is not a primitive, even if the values are the same, false is returned.

Install with npm

$ npm i is-equal-shallow --save

Usage

var equals = require('is-equal-shallow');
equals(object_a, object_b);

Examples

equals({a: true, b: true}, {a: true, b: true});
//=> 'true'

equals({a: true, b: false}, {c: false, b: false});
//=> 'false'

equals({a: true, b: false}, {a: false, b: false});
//=> 'false'

Strict comparison for equality:

equals({a: true, b: true}, {a: true, b: 'true'});
//=> 'false'

When values are not primitives, false is always returned:

equals({ b: {}}, { b: {}});
//=> 'false'

equals({ b: []}, { b: []});
//=> 'false'

Related projects

Other object utils:

• clone-deep: Recursively (deep) clone JavaScript native types, like Object, Array, RegExp, Date as well as primitives.
• for-in: Iterate over the own and inherited enumerable properties of an objecte, and return an object… more
• for-own: Iterate over the own enumerable properties of an object, and return an object with properties… more
• is-plain-object: Returns true if an object was created by the Object constructor.
• isobject: Returns true if the value is an object and not an array or null.

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

---

This file was generated by verb-cli on June 22, 2015.